home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2001 May / SGI IRIX Base Documentation 2001 May.iso / usr / share / catman / g_man / cat3 / OpenGL / gluscaleimage.z / gluscaleimage
Encoding:
Text File  |  2001-04-17  |  18.6 KB  |  199 lines
  1.  
  2.  
  3.  
  4. gggglllluuuuSSSSccccaaaalllleeeeIIIImmmmaaaaggggeeee((((3333GGGG))))              OOOOppppeeeennnnGGGGLLLL RRRReeeeffffeeeerrrreeeennnncccceeee              gggglllluuuuSSSSccccaaaalllleeeeIIIImmmmaaaaggggeeee((((3333GGGG))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      gggglllluuuuSSSSccccaaaalllleeeeIIIImmmmaaaaggggeeee - scale an image to an arbitrary size
  10.  
  11.  
  12. CCCC SSSSPPPPEEEECCCCIIIIFFFFIIIICCCCAAAATTTTIIIIOOOONNNN
  13.      GLint gggglllluuuuSSSSccccaaaalllleeeeIIIImmmmaaaaggggeeee( GLenum _f_o_r_m_a_t,
  14.                           GLsizei _w_I_n,
  15.                           GLsizei _h_I_n,
  16.                           GLenum _t_y_p_e_I_n,
  17.                           const void *_d_a_t_a_I_n,
  18.                           GLsizei _w_O_u_t,
  19.                           GLsizei _h_O_u_t,
  20.                           GLenum _t_y_p_e_O_u_t,
  21.                           GLvoid* _d_a_t_a_O_u_t )
  22.  
  23.  
  24. PPPPAAAARRRRAAAAMMMMEEEETTTTEEEERRRRSSSS
  25.      _f_o_r_m_a_t   Specifies the format of the pixel data.  The following symbolic
  26.               values are valid:  GGGGLLLL____CCCCOOOOLLLLOOOORRRR____IIIINNNNDDDDEEEEXXXX, GGGGLLLL____SSSSTTTTEEEENNNNCCCCIIIILLLL____IIIINNNNDDDDEEEEXXXX,
  27.               GGGGLLLL____DDDDEEEEPPPPTTTTHHHH____CCCCOOOOMMMMPPPPOOOONNNNEEEENNNNTTTT, GGGGLLLL____RRRREEEEDDDD, GGGGLLLL____GGGGRRRREEEEEEEENNNN, GGGGLLLL____BBBBLLLLUUUUEEEE, GGGGLLLL____AAAALLLLPPPPHHHHAAAA, GGGGLLLL____RRRRGGGGBBBB,
  28.               GGGGLLLL____RRRRGGGGBBBBAAAA, GGGGLLLL____BBBBGGGGRRRR, GGGGLLLL____BBBBGGGGRRRRAAAA, GGGGLLLL____LLLLUUUUMMMMIIIINNNNAAAANNNNCCCCEEEE, and GGGGLLLL____LLLLUUUUMMMMIIIINNNNAAAANNNNCCCCEEEE____AAAALLLLPPPPHHHHAAAA.
  29.  
  30.      _w_I_n, _h_I_n Specify in pixels the width and height, respectively, of the
  31.               source image.
  32.  
  33.      _t_y_p_e_I_n   Specifies the data type for _d_a_t_a_I_n. Must be one of
  34.               GGGGLLLL____UUUUNNNNSSSSIIIIGGGGNNNNEEEEDDDD____BBBBYYYYTTTTEEEE, GGGGLLLL____BBBBYYYYTTTTEEEE, GGGGLLLL____BBBBIIIITTTTMMMMAAAAPPPP, GGGGLLLL____UUUUNNNNSSSSIIIIGGGGNNNNEEEEDDDD____SSSSHHHHOOOORRRRTTTT,
  35.               GGGGLLLL____SSSSHHHHOOOORRRRTTTT, GGGGLLLL____UUUUNNNNSSSSIIIIGGGGNNNNEEEEDDDD____IIIINNNNTTTT, GGGGLLLL____IIIINNNNTTTT, GGGGLLLL____FFFFLLLLOOOOAAAATTTT,
  36.               GGGGLLLL____UUUUNNNNSSSSIIIIGGGGNNNNEEEEDDDD____BBBBYYYYTTTTEEEE____3333____3333____2222, GGGGLLLL____UUUUNNNNSSSSIIIIGGGGNNNNEEEEDDDD____BBBBYYYYTTTTEEEE____2222____3333____3333____RRRREEEEVVVV,
  37.               GGGGLLLL____UUUUNNNNSSSSIIIIGGGGNNNNEEEEDDDD____SSSSHHHHOOOORRRRTTTT____5555____6666____5555, GGGGLLLL____UUUUNNNNSSSSIIIIGGGGNNNNEEEEDDDD____SSSSHHHHOOOORRRRTTTT____5555____6666____5555____RRRREEEEVVVV,
  38.               GGGGLLLL____UUUUNNNNSSSSIIIIGGGGNNNNEEEEDDDD____SSSSHHHHOOOORRRRTTTT____4444____4444____4444____4444, GGGGLLLL____UUUUNNNNSSSSIIIIGGGGNNNNEEEEDDDD____SSSSHHHHOOOORRRRTTTT____4444____4444____4444____4444____RRRREEEEVVVV,
  39.               GGGGLLLL____UUUUNNNNSSSSIIIIGGGGNNNNEEEEDDDD____SSSSHHHHOOOORRRRTTTT____5555____5555____5555____1111, GGGGLLLL____UUUUNNNNSSSSIIIIGGGGNNNNEEEEDDDD____SSSSHHHHOOOORRRRTTTT____1111____5555____5555____5555____RRRREEEEVVVV,
  40.               GGGGLLLL____UUUUNNNNSSSSIIIIGGGGNNNNEEEEDDDD____IIIINNNNTTTT____8888____8888____8888____8888, GGGGLLLL____UUUUNNNNSSSSIIIIGGGGNNNNEEEEDDDD____IIIINNNNTTTT____8888____8888____8888____8888____RRRREEEEVVVV,
  41.               GGGGLLLL____UUUUNNNNSSSSIIIIGGGGNNNNEEEEDDDD____IIIINNNNTTTT____11110000____11110000____11110000____2222, and GGGGLLLL____UUUUNNNNSSSSIIIIGGGGNNNNEEEEDDDD____IIIINNNNTTTT____2222____11110000____11110000____11110000____RRRREEEEVVVV.
  42.  
  43.      _d_a_t_a_I_n   Specifies a pointer to the source image.
  44.  
  45.      _w_O_u_t, _h_O_u_t
  46.               Specify the width and height, respectively, in pixels of the
  47.               destination image.
  48.  
  49.      _t_y_p_e_O_u_t  Specifies the data type for _d_a_t_a_O_u_t. Must be one of
  50.               GGGGLLLL____UUUUNNNNSSSSIIIIGGGGNNNNEEEEDDDD____BBBBYYYYTTTTEEEE, GGGGLLLL____BBBBYYYYTTTTEEEE, GGGGLLLL____BBBBIIIITTTTMMMMAAAAPPPP, GGGGLLLL____UUUUNNNNSSSSIIIIGGGGNNNNEEEEDDDD____SSSSHHHHOOOORRRRTTTT,
  51.               GGGGLLLL____SSSSHHHHOOOORRRRTTTT, GGGGLLLL____UUUUNNNNSSSSIIIIGGGGNNNNEEEEDDDD____IIIINNNNTTTT, GGGGLLLL____IIIINNNNTTTT, GGGGLLLL____FFFFLLLLOOOOAAAATTTT,
  52.               GGGGLLLL____UUUUNNNNSSSSIIIIGGGGNNNNEEEEDDDD____BBBBYYYYTTTTEEEE____3333____3333____2222, GGGGLLLL____UUUUNNNNSSSSIIIIGGGGNNNNEEEEDDDD____BBBBYYYYTTTTEEEE____2222____3333____3333____RRRREEEEVVVV,
  53.               GGGGLLLL____UUUUNNNNSSSSIIIIGGGGNNNNEEEEDDDD____SSSSHHHHOOOORRRRTTTT____5555____6666____5555, GGGGLLLL____UUUUNNNNSSSSIIIIGGGGNNNNEEEEDDDD____SSSSHHHHOOOORRRRTTTT____5555____6666____5555____RRRREEEEVVVV,
  54.               GGGGLLLL____UUUUNNNNSSSSIIIIGGGGNNNNEEEEDDDD____SSSSHHHHOOOORRRRTTTT____4444____4444____4444____4444, GGGGLLLL____UUUUNNNNSSSSIIIIGGGGNNNNEEEEDDDD____SSSSHHHHOOOORRRRTTTT____4444____4444____4444____4444____RRRREEEEVVVV,
  55.               GGGGLLLL____UUUUNNNNSSSSIIIIGGGGNNNNEEEEDDDD____SSSSHHHHOOOORRRRTTTT____5555____5555____5555____1111, GGGGLLLL____UUUUNNNNSSSSIIIIGGGGNNNNEEEEDDDD____SSSSHHHHOOOORRRRTTTT____1111____5555____5555____5555____RRRREEEEVVVV,
  56.               GGGGLLLL____UUUUNNNNSSSSIIIIGGGGNNNNEEEEDDDD____IIIINNNNTTTT____8888____8888____8888____8888, GGGGLLLL____UUUUNNNNSSSSIIIIGGGGNNNNEEEEDDDD____IIIINNNNTTTT____8888____8888____8888____8888____RRRREEEEVVVV,
  57.               GGGGLLLL____UUUUNNNNSSSSIIIIGGGGNNNNEEEEDDDD____IIIINNNNTTTT____11110000____11110000____11110000____2222, or GGGGLLLL____UUUUNNNNSSSSIIIIGGGGNNNNEEEEDDDD____IIIINNNNTTTT____2222____11110000____11110000____11110000____RRRREEEEVVVV.
  58.  
  59.  
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. gggglllluuuuSSSSccccaaaalllleeeeIIIImmmmaaaaggggeeee((((3333GGGG))))              OOOOppppeeeennnnGGGGLLLL RRRReeeeffffeeeerrrreeeennnncccceeee              gggglllluuuuSSSSccccaaaalllleeeeIIIImmmmaaaaggggeeee((((3333GGGG))))
  71.  
  72.  
  73.  
  74.      _d_a_t_a_O_u_t  Specifies a pointer to the destination image.
  75.  
  76. DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  77.      gggglllluuuuSSSSccccaaaalllleeeeIIIImmmmaaaaggggeeee scales a pixel image using the appropriate pixel store
  78.      modes to unpack data from the source image and pack data into the
  79.      destination image.
  80.  
  81.      When shrinking an image, gggglllluuuuSSSSccccaaaalllleeeeIIIImmmmaaaaggggeeee uses a box filter to sample the
  82.      source image and create pixels for the destination image.  When
  83.      magnifying an image, the pixels from the source image are linearly
  84.      interpolated to create the destination image.
  85.  
  86.      A return value of zero indicates success, otherwise a GLU error code is
  87.      returned (see gggglllluuuuEEEErrrrrrrroooorrrrSSSSttttrrrriiiinnnngggg).
  88.  
  89.      See the ggggllllRRRReeeeaaaaddddPPPPiiiixxxxeeeellllssss reference page for a description of the acceptable
  90.      values for the _f_o_r_m_a_t, _t_y_p_e_I_n, and _t_y_p_e_O_u_t parameters.
  91.  
  92. NNNNOOOOTTTTEEEESSSS
  93.      Formats GGGGLLLL____BBBBGGGGRRRR, and GGGGLLLL____BBBBGGGGRRRRAAAA, and types GGGGLLLL____UUUUNNNNSSSSIIIIGGGGNNNNEEEEDDDD____BBBBYYYYTTTTEEEE____3333____3333____2222,
  94.      GGGGLLLL____UUUUNNNNSSSSIIIIGGGGNNNNEEEEDDDD____BBBBYYYYTTTTEEEE____2222____3333____3333____RRRREEEEVVVV, GGGGLLLL____UUUUNNNNSSSSIIIIGGGGNNNNEEEEDDDD____SSSSHHHHOOOORRRRTTTT____5555____6666____5555,
  95.      GGGGLLLL____UUUUNNNNSSSSIIIIGGGGNNNNEEEEDDDD____SSSSHHHHOOOORRRRTTTT____5555____6666____5555____RRRREEEEVVVV, GGGGLLLL____UUUUNNNNSSSSIIIIGGGGNNNNEEEEDDDD____SSSSHHHHOOOORRRRTTTT____4444____4444____4444____4444,
  96.      GGGGLLLL____UUUUNNNNSSSSIIIIGGGGNNNNEEEEDDDD____SSSSHHHHOOOORRRRTTTT____4444____4444____4444____4444____RRRREEEEVVVV, GGGGLLLL____UUUUNNNNSSSSIIIIGGGGNNNNEEEEDDDD____SSSSHHHHOOOORRRRTTTT____5555____5555____5555____1111,
  97.      GGGGLLLL____UUUUNNNNSSSSIIIIGGGGNNNNEEEEDDDD____SSSSHHHHOOOORRRRTTTT____1111____5555____5555____5555____RRRREEEEVVVV, GGGGLLLL____UUUUNNNNSSSSIIIIGGGGNNNNEEEEDDDD____IIIINNNNTTTT____8888____8888____8888____8888,
  98.      GGGGLLLL____UUUUNNNNSSSSIIIIGGGGNNNNEEEEDDDD____IIIINNNNTTTT____8888____8888____8888____8888____RRRREEEEVVVV, GGGGLLLL____UUUUNNNNSSSSIIIIGGGGNNNNEEEEDDDD____IIIINNNNTTTT____11110000____11110000____11110000____2222, and
  99.      GGGGLLLL____UUUUNNNNSSSSIIIIGGGGNNNNEEEEDDDD____IIIINNNNTTTT____2222____11110000____11110000____11110000____RRRREEEEVVVV are only available if the GL version is
  100.      1.2 or greater.
  101.  
  102. EEEERRRRRRRROOOORRRRSSSS
  103.      GGGGLLLLUUUU____IIIINNNNVVVVAAAALLLLIIIIDDDD____VVVVAAAALLLLUUUUEEEE is returned if _w_I_n, _h_I_n, _w_O_u_t, or _h_O_u_t is negative.
  104.  
  105.      GGGGLLLLUUUU____IIIINNNNVVVVAAAALLLLIIIIDDDD____EEEENNNNUUUUMMMM is returned if _f_o_r_m_a_t, _t_y_p_e_I_n, or _t_y_p_e_O_u_t is not legal.
  106.  
  107.      GGGGLLLLUUUU____IIIINNNNVVVVAAAALLLLIIIIDDDD____OOOOPPPPEEEERRRRAAAATTTTIIIIOOOONNNN is returned if _t_y_p_e_I_n or _t_y_p_e_O_u_t is
  108.      GGGGLLLL____UUUUNNNNSSSSIIIIGGGGNNNNEEEEDDDD____BBBBYYYYTTTTEEEE____3333____3333____2222 or GGGGLLLL____UUUUNNNNSSSSIIIIGGGGNNNNEEEEDDDD____BBBBYYYYTTTTEEEE____2222____3333____3333____RRRREEEEVVVV and _f_o_r_m_a_t is not
  109.      GGGGLLLL____RRRRGGGGBBBB.
  110.  
  111.      GGGGLLLLUUUU____IIIINNNNVVVVAAAALLLLIIIIDDDD____OOOOPPPPEEEERRRRAAAATTTTIIIIOOOONNNN is returned if _t_y_p_e_I_n or _t_y_p_e_O_u_t is
  112.      GGGGLLLL____UUUUNNNNSSSSIIIIGGGGNNNNEEEEDDDD____SSSSHHHHOOOORRRRTTTT____5555____6666____5555 or GGGGLLLL____UUUUNNNNSSSSIIIIGGGGNNNNEEEEDDDD____SSSSHHHHOOOORRRRTTTT____5555____6666____5555____RRRREEEEVVVV and _f_o_r_m_a_t is not
  113.      GGGGLLLL____RRRRGGGGBBBB.
  114.  
  115.      GGGGLLLLUUUU____IIIINNNNVVVVAAAALLLLIIIIDDDD____OOOOPPPPEEEERRRRAAAATTTTIIIIOOOONNNN is returned if _t_y_p_e_I_n or _t_y_p_e_O_u_t is
  116.      GGGGLLLL____UUUUNNNNSSSSIIIIGGGGNNNNEEEEDDDD____SSSSHHHHOOOORRRRTTTT____4444____4444____4444____4444 or GGGGLLLL____UUUUNNNNSSSSIIIIGGGGNNNNEEEEDDDD____SSSSHHHHOOOORRRRTTTT____4444____4444____4444____4444____RRRREEEEVVVV and _f_o_r_m_a_t is
  117.      neither GGGGLLLL____RRRRGGGGBBBBAAAA nor GGGGLLLL____BBBBGGGGRRRRAAAA.
  118.  
  119.      GGGGLLLLUUUU____IIIINNNNVVVVAAAALLLLIIIIDDDD____OOOOPPPPEEEERRRRAAAATTTTIIIIOOOONNNN is returned if _t_y_p_e_I_n or _t_y_p_e_O_u_t is
  120.      GGGGLLLL____UUUUNNNNSSSSIIIIGGGGNNNNEEEEDDDD____SSSSHHHHOOOORRRRTTTT____5555____5555____5555____1111 or GGGGLLLL____UUUUNNNNSSSSIIIIGGGGNNNNEEEEDDDD____SSSSHHHHOOOORRRRTTTT____1111____5555____5555____5555____RRRREEEEVVVV and _f_o_r_m_a_t is
  121.      neither GGGGLLLL____RRRRGGGGBBBBAAAA nor GGGGLLLL____BBBBGGGGRRRRAAAA.
  122.  
  123.      GGGGLLLLUUUU____IIIINNNNVVVVAAAALLLLIIIIDDDD____OOOOPPPPEEEERRRRAAAATTTTIIIIOOOONNNN is returned if _t_y_p_e_I_n or _t_y_p_e_O_u_t is
  124.      GGGGLLLL____UUUUNNNNSSSSIIIIGGGGNNNNEEEEDDDD____IIIINNNNTTTT____8888____8888____8888____8888 or GGGGLLLL____UUUUNNNNSSSSIIIIGGGGNNNNEEEEDDDD____IIIINNNNTTTT____8888____8888____8888____8888____RRRREEEEVVVV and _f_o_r_m_a_t is
  125.      neither GGGGLLLL____RRRRGGGGBBBBAAAA nor GGGGLLLL____BBBBGGGGRRRRAAAA.
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. gggglllluuuuSSSSccccaaaalllleeeeIIIImmmmaaaaggggeeee((((3333GGGG))))              OOOOppppeeeennnnGGGGLLLL RRRReeeeffffeeeerrrreeeennnncccceeee              gggglllluuuuSSSSccccaaaalllleeeeIIIImmmmaaaaggggeeee((((3333GGGG))))
  137.  
  138.  
  139.  
  140.      GGGGLLLLUUUU____IIIINNNNVVVVAAAALLLLIIIIDDDD____OOOOPPPPEEEERRRRAAAATTTTIIIIOOOONNNN is returned if _t_y_p_e_I_n or _t_y_p_e_O_u_t is
  141.      GGGGLLLL____UUUUNNNNSSSSIIIIGGGGNNNNEEEEDDDD____IIIINNNNTTTT____11110000____11110000____11110000____2222 or GGGGLLLL____UUUUNNNNSSSSIIIIGGGGNNNNEEEEDDDD____IIIINNNNTTTT____2222____11110000____11110000____11110000____RRRREEEEVVVV and _f_o_r_m_a_t
  142.      is neither GGGGLLLL____RRRRGGGGBBBBAAAA nor GGGGLLLL____BBBBGGGGRRRRAAAA.
  143.  
  144. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  145.      ggggllllDDDDrrrraaaawwwwPPPPiiiixxxxeeeellllssss, ggggllllRRRReeeeaaaaddddPPPPiiiixxxxeeeellllssss, gggglllluuuuBBBBuuuuiiiilllldddd1111DDDDMMMMiiiippppmmmmaaaappppssss, gggglllluuuuBBBBuuuuiiiilllldddd2222DDDDMMMMiiiippppmmmmaaaappppssss,
  146.      gggglllluuuuBBBBuuuuiiiilllldddd3333DDDDMMMMiiiippppmmmmaaaappppssss,  gggglllluuuuEEEErrrrrrrroooorrrrSSSSttttrrrriiiinnnngggg
  147.  
  148.  
  149.  
  150.  
  151.  
  152.  
  153.  
  154.  
  155.  
  156.  
  157.  
  158.  
  159.  
  160.  
  161.  
  162.  
  163.  
  164.  
  165.  
  166.  
  167.  
  168.  
  169.  
  170.  
  171.  
  172.  
  173.  
  174.  
  175.  
  176.  
  177.  
  178.  
  179.  
  180.  
  181.  
  182.  
  183.  
  184.  
  185.  
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.                                                                         PPPPaaaaggggeeee 3333
  196.  
  197.  
  198.  
  199.